Value Variables
Identifier:
org.eclipse.core.variables.valueVariables
Since:
3.0
Description:
This extension point provides a mechanism for defining variables used for string substitution. A value variable has a static value.
Configuration Markup:
<!ELEMENT extension (variable*)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - a fully qualified identifier of the target extension point
- id - an optional identifier of the extension instance
- name - an optional name of the extension instance
<!ELEMENT variable EMPTY>
<!ATTLIST variable
name CDATA #REQUIRED
initialValue CDATA #IMPLIED
initializerClass CDATA #IMPLIED
description CDATA #IMPLIED>
- name - specifies a unique name for this variable.
- initialValue - specifies the initial value for this variable. When specified, an initializerClass attribute must not be specified.
- initializerClass - specifies the fully qualified name of the Java class that implements org.eclipse.core.variables.IValueVariableInitializer. When specified, an initialValue attribute must not be specified.
- description - specifies a human-readable description of this variable.
Examples:
The following is an example of a value variable contribution with an initial value:
<extension point=
"org.eclipse.core.variables.valueVariables"
>
<variable
name=
"FOO_HOME"
initialValue=
"/usr/local/foo"
>
</variable>
</extension>
In the example above, the specified variable is created with the initial value "/usr/local/foo".
The following is an example of a value variable contribution with an initializer class:
<extension point=
"org.eclipse.core.variables.valueVariables"
>
<variable
name=
"FOO_HOME"
initializerClass=
"com.example.FooLocator"
>
</variable>
</extension>
In the example above, the variable FOO_HOME is created and the class "com.example.FooLocator" will be
used to initialize the value the first time it's requested.
API Information:
Value of the attribute initializerClass must be a fully qualified name of a Java class that implements the interface org.eclipse.core.variables.IValueVariableInitializer.